Skip to main content

Get list of products

GET /api/v1/products

Description

Retrieve a list of products based on various filters and pagination options.

URL:

  • Raw URL: /api/v1/products?productByDisplays=INTERNAL&productByDeleted=&productByCodes=&productByIds=&productSearch=&productDateRange=&order=DESC&page=&limit=
  • Host:
  • Path: /api/v1/products
/api/v1/products?productByDisplays=INTERNAL&productByDeleted=<string>&productByCodes=<string>&productByIds=<string>&productSearch=<string>&productDateRange=<string>&order=DESC&page=<string>&limit=<string>

Query Params

Paramvalue
productByDisplaysINTERNAL
productByDeletedstring
productByCodesstring
productByIdsstring
productSearchstring
productDateRangestring
orderDESC
pagestring
limitstring

🔑 Authentication bearer

ParamvalueType
Auth{{tenantUserAccessToken}}string

Response: 200

{
"nextPage": null,
"previousPage": null,
"currentPage": 1,
"results": [
{
"_id": "{{$randomId}}",
"name": "Tasty Plastic Computer",
"overview": "Shirt",
"requirements": ["new", "old"],
"code": "tasty_plastic_computer",
"photo": "{{$randomPhotoUrl}}",
"config": {
"mobileApp": [
{
"label": "Webhook URL",
"key": "webhookUrl",
"required": true,
"value": "string",
"valueType": "string",
"formType": "input",
"_id": "{{$randomId}}",
"formOptions": []
}
],
"pwaApp": [
{
"label": "Webhook URL",
"key": "webhookUrl",
"required": true,
"value": "string",
"valueType": "string",
"formType": "input",
"_id": "{{$randomId}}",
"formOptions": []
}
],
"webApp": [
{
"label": "Webhook URL",
"key": "webhookUrl",
"required": true,
"value": "string",
"valueType": "string",
"formType": "input",
"_id": "{{$randomId}}",
"formOptions": []
}
],
"adminApp": [
{
"label": "Webhook URL",
"key": "webhookUrl",
"required": true,
"value": "string",
"valueType": "string",
"formType": "input",
"_id": "{{$randomId}}",
"formOptions": []
}
]
},
"services": [],
"tenant": "{{$randomTenantId}}",
"display": "PUBLIC",
"type": "TENANT",
"category": "WHITE_LABEL",
"classification": [],
"bio": {
"title": "input_firewall.rms",
"description": "If we override the capacitor, we can get to the EXE protocol through the online XML driver!"
},
"deleted": false,
"createdBy": "SYSTEM",
"deletedBy": null,
"updatedBy": null,
"createdAt": "{{$timestamp}}",
"updatedAt": "{{$timestamp}}",
"__v": 0
}
],
"perPageLimit": 20,
"totalRecords": 1,
"totalPages": 1
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request GET \ 
--url /api/v1/products \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!